

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Document Options [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, RTF Report,RTF Report Document Options (Enhanced Generator),RTF Report Advanced Options,RTF Report Switch Generator,RTF Report In MS Open Office,RTF Report Open Office Display,Switch RTF Generator">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Document Options</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="resource_documents.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="rtf_element_filters.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText">The RTF report</span><span class="f_UIControl"> </span><span class="f_BodyText">options enable you to set type filters and order the elements. You can access the options from two different places; the start point affects the persistence of options selected:</span></p>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=1><span class="f_NumberedList">If you access the options on the </span><span class="f_UIControl">Options</span><span class="f_NumberedList"> and </span><span class="f_UIControl">Advanced</span><span class="f_NumberedList"> tabs of the </span><span class="f_UIControl"><a href="rtfdialogoptions.htm">Generate RTF Documentation</a></span><span class="f_NumberedList"> dialog, you can define settings for the current report to be run. Selections are non-persistent, and are reset when you exit the dialog or select a different template.</span></li>
<li value=2><span class="f_NumberedList">If you access the options by clicking on the </span><span class="f_MenuKeyField"><a href="fileandprintoptions.htm">File | Document Options</a></span><span class="f_NumberedList"> menu option on the <a href="rtfstyletemplateeditor.htm">RTF Style Template Editor</a> dialog, the settings are saved with the template as the default settings for any run of this report; the </span><span class="f_UIControl">Document Options</span><span class="f_NumberedList"> dialog provides the options from </span><span class="f_NumberedList" style="font-weight: bold;">both</span><span class="f_NumberedList"> of the </span><span class="f_UIControl">Options</span><span class="f_NumberedList"> and </span><span class="f_UIControl">Advanced</span><span class="f_NumberedList"> tabs of the </span><span class="f_UIControl">Generate RTF Documentation</span><span class="f_NumberedList"> dialog, with three <a href="rtfdocumentoptions.htm#Except">minor differences</a>.</span></li>
</ol>
<p class="p_BodyText"><span class="f_BodyText">The </span><span class="f_UIControl">Options</span><span class="f_BodyText"> tab of the </span><span class="f_UIControl">Generate RTF Documentation</span><span class="f_BodyText"> dialog has the following fields:</span></p>
<p class="p_TextIndentedL2"><img src="generatertfdocoptions.png" width="601" height="387" border="0" alt="GenerateRTFDocOptions"></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="184" bgcolor="#e3e6ed" style="width:184px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Option</span></p>
</td>
<td valign="top" width="484" bgcolor="#e3e6ed" style="width:484px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Use to</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="184" style="width:184px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_UIControl">Filter</span></p>
</td>
<td valign="top" width="484" style="width:484px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">&nbsp;</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="184" style="width:184px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Only include objects</span></p>
</td>
<td valign="top" width="484" style="width:484px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Filter elements according to date created or modified. In the first two fields, select the qualifiers from the drop-down lists. In the third field, select the appropriate date.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="184" style="width:184px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Where Package Phase</span></p>
</td>
<td valign="top" width="484" style="width:484px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Filter elements according to the value of the </span><span class="f_MenuKeyField">Package Phase</span><span class="f_Tabletext"> field. In the first field select the qualifier, and in the second type the required phase (or leave the default value </span><span class="f_Tabletext" style="font-weight: bold;">All</span><span class="f_Tabletext">).</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="184" style="width:184px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">With element status</span></p>
</td>
<td valign="top" width="484" style="width:484px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Filter elements according to status. In the first field, select the qualifier (</span><span class="f_Tabletext" style="font-weight: bold;">like</span><span class="f_Tabletext">, </span><span class="f_Tabletext" style="font-weight: bold;">not like</span><span class="f_Tabletext">, </span><span class="f_Tabletext" style="font-weight: bold;">in</span><span class="f_Tabletext">, </span><span class="f_Tabletext" style="font-weight: bold;">not in</span><span class="f_Tabletext">) and in the second field type the value to be used. Values should be enclosed in quotes; for example: &quot;Proposed&quot;. If you type more than one value, separate them with a comma; for example: &quot;Proposed&quot;, &quot;Implemented&quot;.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="184" style="width:184px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Connector Direction</span></p>
</td>
<td valign="top" width="484" style="width:484px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Filter connectors according to direction. </span></p>
<p class="p_Tabletext"><span class="f_Tabletext">If you select </span><span class="f_MenuKeyField">Both</span><span class="f_Tabletext">, the connector is documented twice; once for the source element and once for the target. For the remaining two values, the connector is documented only for the source or target element, as appropriate.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="184" style="width:184px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_UIControl">Order</span></p>
</td>
<td valign="top" width="484" style="width:484px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">&nbsp;</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="184" style="width:184px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Packages by</span></p>
</td>
<td valign="top" width="484" style="width:484px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Order packages in the generated documentation in either ascending or descending order of Name, Tree Order, Modified Date or Created Date.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="184" style="width:184px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Elements by</span></p>
</td>
<td valign="top" width="484" style="width:484px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Order elements in the generated documentation in either ascending or descending order of Name, Tree Order, Modified Date or Created Date.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="184" style="width:184px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Diagrams by</span></p>
</td>
<td valign="top" width="484" style="width:484px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Order diagrams in the generated documentation in either ascending or descending order of Name, Tree Order, Modified Date or Created Date.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="184" style="width:184px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_UIControl">Exclude details for</span></p>
</td>
<td valign="top" width="484" style="width:484px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Exclude all elements of the selected type or types from the generated document.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="184" style="width:184px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_UIControl">Exclude connector type</span></p>
</td>
<td valign="top" width="484" style="width:484px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Exclude all connectors of the selected type or types from the generated document.</span></p>
</td>
</tr>
</table>
</div>
<p class="p_BodyText"><span class="f_BodyText">&nbsp;</span><br>
<span class="f_BodyText">The<a name="advanced"></a> </span><span class="f_UIControl">Advanced</span><span class="f_BodyText"> tab of the </span><span class="f_UIControl">Generate RTF Documentation</span><span class="f_BodyText"> dialog has the following fields:</span></p>
<p class="p_TextIndentedL2"><img src="generatertfdocadvanced.png" width="600" height="386" border="0" alt="GenerateRTFDocAdvanced"></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="185" bgcolor="#e3e6ed" style="width:185px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Option</span></p>
</td>
<td valign="top" width="485" bgcolor="#e3e6ed" style="width:485px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Use to</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="185" style="width:185px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Hide 'note-less' elements</span></p>
</td>
<td valign="top" width="485" style="width:485px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Exclude all elements without notes from the documentation.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="185" style="width:185px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Diagram Format</span></p>
</td>
<td valign="top" width="485" style="width:485px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Set the diagram format for the images included within the documentation to either Metafile or Bitmap.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="185" style="width:185px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Skip root package</span></p>
</td>
<td valign="top" width="485" style="width:485px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Exclude the parent package from the documentation and include only the child packages.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="185" style="width:185px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Overwrite document fields</span></p>
</td>
<td valign="top" width="485" style="width:485px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Generate a document where the value fields defined in a document section are overwritten with the actual value text. If you open the generated report in Word, you can format the text but you cannot display the original field code.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">If the checkbox is </span><span class="f_Tabletext" style="font-style: italic;">deselected</span><span class="f_Tabletext">, the fields remain and are populated with the appropriate values; when you display the generated report in Word, you can right-click on the field and toggle between the value text and the field code.</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 4px 2px 4px 2px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" bgcolor="#efeff7" style="background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td bgcolor="#f7f7ff" style="background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">If you use Open Office as your text editor, you </span><span class="f_TiporNoteText" style="font-weight: bold;">must</span><span class="f_TiporNoteText"> select this checkbox to show the field values. Open Office defaults to showing the field codes only, and you cannot toggle to the field values.</span></p>
</td>
</tr>
</table>
</div>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="185" style="width:185px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Adjust Heading Levels</span></p>
</td>
<td valign="top" width="485" style="width:485px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Enable the RTF Generator to automatically restrict the levels of heading generated for nested sub-packages in a document.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">The generator reproduces heading levels down to the value you set. For example, if you have four nested levels of sub-packages and you set this field to:</span></p>
<ul style="text-indent: 0px; margin-left: 15px; list-style-position: outside;">
<li><span class="f_Tabletext" style="font-weight: bold;">Heading 2</span><span class="f_Tabletext">, all sub-packages in the report are documented under level 2 headings.</span></li>
<li><span class="f_Tabletext" style="font-weight: bold;">Heading 4</span><span class="f_Tabletext">, the first level of subpackages are documented under level 2 headings, the next level under level 3 headings, and the remainder all under level 4 headings.</span></li>
<li><span class="f_Tabletext" style="font-weight: bold;">Heading 6</span><span class="f_Tabletext">, the first level of subpackages are documented under level 2 headings, the next level under level 3 headings, the next under level 4 headings, and the next under level 5 headings. If you added further levels of sub-package they would all be documented under level 6 headings.</span></li>
</ul>
<p class="p_Tabletext"><span class="f_Tabletext">The field defaults to </span><span class="f_Tabletext" style="font-weight: bold;">Heading 9</span><span class="f_Tabletext"> to accommodate the maximum number of levels of nested subpackages.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="185" style="width:185px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">No bookmarks</span></p>
</td>
<td valign="top" width="485" style="width:485px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Stop RTF bookmarks being inserted into the generated document.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="185" style="width:185px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Hide &lt;Anonymous&gt; elements</span></p>
</td>
<td valign="top" width="485" style="width:485px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Hide anonymous elements in the documentation.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="185" style="width:185px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Use style defined in template for notes</span></p>
</td>
<td valign="top" width="485" style="width:485px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Apply the template-defined style for notes instead of the RTF styles defined within the element.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="185" style="width:185px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Disable large OLE file support</span></p>
</td>
<td valign="top" width="485" style="width:485px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Disable support for large Object Linking and Embedding (OLE) files.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="185" style="width:185px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Insert page breaks when generating a Master Document</span></p>
</td>
<td valign="top" width="485" style="width:485px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Insert a page break after each <a href="virtualdocuments.htm">Model Document in a Master Document</a>.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="185" style="width:185px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Switch generator</span></p>
</td>
<td valign="top" width="485" style="width:485px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Switch from this </span><span class="f_UIControl">Generate RTF Documentation</span><span class="f_Tabletext"> dialog (the Enhanced Template Driven Generator) to the </span><span class="f_Tabletext"><a href="documentingyourproject.htm">Rich Text Format Report dialog</a></span><span class="f_Tabletext"> (Legacy Generator).</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 4px 2px 4px 2px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" bgcolor="#efeff7" style="background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td bgcolor="#f7f7ff" style="background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">This button is not available if you displayed the dialog from the</span><span class="f_UIControl"> Element List</span><span class="f_TiporNoteText"> or </span><span class="f_UIControl">Model Search</span><span class="f_TiporNoteText">.</span></p>
</td>
</tr>
</table>
</div>
</td>
</tr>
</table>
</div>
<p class="p_BodyText"><a name="except"></a><span class="f_BodyText">The </span><span class="f_UIControl">Document Options</span><span class="f_BodyText"> dialog provides both sets of options, except for:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">The </span><span class="f_MenuKeyField">Switch generator</span><span class="f_Bulletlist1"> button</span></li>
<li><span class="f_Bulletlist1">The </span><span class="f_MenuKeyField">Disable large OLE file support</span><span class="f_Bulletlist1"> option</span></li>
<li><span class="f_Bulletlist1">The </span><span class="f_MenuKeyField">Insert page breaks when generating a Master Document</span><span class="f_Bulletlist1"> option.</span></li>
</ul>
<p class="p_BodyText"><span class="f_BodyText">Click on the </span><span class="f_MenuKeyField">OK</span><span class="f_BodyText"> button to save your changes.</span></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
